VoicePlan Web Services

VoiceCheck exposes a web service that allows the creation of a VoicePlan—essentially a data import. This web service enables creating new VoicePlans as well as updating and deleting existing VoicePlans from the VoiceCheck server. When this web service is invoked, VoiceCheck validates the system for the following:

  • If there is no matching VoicePlan name, a new VoicePlan is created.
  • If there is a matching VoicePlan name, a new VoicePlan is not created.
  • A VoicePlan without Description, VoiceForm and Section Steps is considered invalid and not created.
  • A VoicePlan is not created if the VoiceForm associated with the VoicePlan is not found in the VoiceCheck server.

When VoiceCheck receives this message for reading, updating, and deleting of VoicePlans, the following validations are taken into consideration:

  • If the VoicePlan name does not exist in VoiceCheck, no details are returned in the response.
  • If the VoicePlan exists, the web service can update only the name of the VoicePlan.
  • A VoicePlan can be deleted even if it references to some entity in VoiceCheck.

Create VoicePlan Details

REST Web Service

WADL: <http or https>://<host>:<port>/VoiceCheck/services/voiceplan?_wadl

URL: <http or https>://<host>:<port>/VoiceCheck/services/voiceplan

Method: POST

Content-Type: application/json;charset=UTF-8

Message Body: JSON as outlined in the schema in the WADL. The elements are described in the input elements table.

Response: On success, HTTP Status 200 with Payload “VoicePlan saved”. On failure, the system returns an error. Any HTTP status code other than 200 or 204 is considered an error. When possible, the host system should return a body for errors.

POST Parameters

A VoicePlan file with valid parameters in the body.

READ VoicePlan DETAILS

REST WEB SERVICE

WADL: <http or https>://<host>:<port>/VoiceCheck/services/voiceplan?_wadl

URL: <http or https>://<host>:<port>/VoiceCheck/services/voiceplan/{planIdentifier}

Method: GET

Content-Type: application/json;charset=UTF-8

Response: On success, HTTP Status 200 with or without a body. On failure, the system returns an error.

UPDATE VoicePlan DETAILS

WADL: <http or https>://<host>:<port>/VoiceCheck/services/voiceplan?_wadl

URL: <http or https>://<host>:<port>/VoiceCheck/services/voiceplan/update/

Method: POST

Content-Type: application/json;charset=UTF-8

Response: On success, HTTP Status 200 with or without a body. On failure, the system returns an error.

POST Parameters

A VoicePlan file with updated parameters in the body.

DELETE VoicePlan DETAILS

WADL: <http or https>://<host>:<port>/VoiceCheck/services/voiceplan?_wadl

URL: <http or https>://<host>:<port>/VoiceCheck/services/voiceplan/{planIdentifier}

Method: DELETE

Response: On success, HTTP Status 200 with or without a body. On failure, the system returns an error.

INPUT ELEMENTS

PROPERTY TYPE REQ’D DEFINITION VALIDATION
planIdentifier

String

Yes The name of the VoicePlan Must be unique in VoiceCheck